home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 2 / Gold Medal Software Volume 2 (Gold Medal) (1994).iso / utils / rcd21.arj / RCD.DOC < prev    next >
Text File  |  1993-10-31  |  16KB  |  456 lines
  1.  
  2.  
  3.                 RCD version 2.1
  4.                 (Ray's Change Directory)
  5.             
  6.                by Ray Van Tassle
  7.                1020 Fox Run Lane
  8.              Algonquin, Ill, 60102
  9.                 (708)-658-4941
  10.                 November 1, 1993
  11.  
  12.     RCD program and manual copyright(c) 1990-1993 by Ray Van Tassle.
  13.  
  14.     Abstract: 
  15.     
  16.     RCD is a set of programs to let you change the default 
  17.     disk/directory quickly & easily, in a "do what I mean" manner.  
  18.     You can specify all or part of the name of the directory you 
  19.     want to go to, and RCD will do it's best to figure out which 
  20.     directory you mean, and on which disk.  And with the 
  21.     new systems being delivered with 100+ MB disks standard, you can 
  22.     potentially have a lot of drives, both physical & logical 
  23.     (drives in DOS extended partitions, and in STACKER & SPEEDSTOR 
  24.     compressed volumes).
  25.     
  26.     RCD is a companion (but totally independent) program to WIZ, my
  27.     lightning fast file finder.
  28.     
  29.  
  30.     RCD is shareware, NOT freeware!!!
  31.  
  32.     You are granted a limited 21 day evaluation license. At the end
  33.     of that period, you should either delete it and stop using it,
  34.     or send in the registration fee of $15.
  35.  
  36.  
  37.     QUICK-START
  38.     -----------
  39.     For a quick start, so you don't have to read this manual, 
  40.     execute "RCDSCAN".
  41.     
  42.     Then you can change to ANY directory on any disk by typing "RCD" 
  43.     and all or part of the desired directory name.
  44.  
  45.  
  46.     ACKNOWLEDGEMENTS--and COMPARISION TO OTHER PROGRAMS
  47.     ---------------------------------------------------
  48.     
  49.     Norton's NCD gave me the initial idea for writing RCD, along 
  50.     with ideas on improvement.  NCD will only work on the current 
  51.     disk; it has a spiffy user display, but I consider it quite 
  52.     limited in terms of looking at other disks, and weak in finding 
  53.     approximate matches on directory names.  Ledbetter's LCD is 
  54.     similar in function to RCD, but isn't quite as powerful in 
  55.     matching, is quite a bit slower in building the index (SCAN), 
  56.     and chokes on network drives that are configured, but off-line 
  57.     (I use $25NETWORK, Little Big Lan, and Fastlynx's EBOX).
  58.     
  59.     Time to build index (483 directories on 10 partitions (drives), no
  60.     disk cache, 7 MHZ 286):
  61.         RCDSCAN v2.1    LCD v4.00a    NCD v4.50
  62.         ------------    ----------    ---------
  63.         17 seconds    130 seconds    170 seconds
  64.         
  65.     LCD does have the capability to do a MD & RD within itself, and
  66.     make the corresponding change in the index file, but this must 
  67.     be invoked on the DOS command line; it doesn't work with 
  68.     directories created/deleted/renamed/moved internally within
  69.     other shells or utilities.  And RCDSCAN is so fast that it's not
  70.     a big burden to run it after modifying your directory structure.
  71.  
  72.  
  73.     Directory ordering
  74.     ------------------
  75.     In my first cut at RCD, I didn't sort the directories, but just
  76.     displayed them in arbitrary order.  This was obnoxious, so I then
  77.     sorted them alphabetically, for each disk.  This is kind of like
  78.     NCD does it, and is exactly the way that LCD does it.  But I didn't
  79.     like that either--it seemed to me that all the directories named
  80.     "FOO" should be next to one another on the display, no matter what
  81.     disk they were on.  After thinking about it some more, a light
  82.     dawned:  a disk name is really a type of "super directory", especially
  83.     when you consider large (200MB +) disks divided into several logical
  84.     partitions.  It doesn't make any more sense to group them by disk than
  85.     it does to group them by parent-directory.
  86.     
  87.     So RCD sorts the directories strictly by name, no matter what the
  88.     parent directory is (be it disk or normal directory).
  89.         
  90.     
  91.     MANUAL
  92.     ------
  93.     RCD is two programs and one data file. The programs are:
  94.         RCDSCAN - Examines your disks, and builds a data-base
  95.               containing the directory & disk names.
  96.               
  97.         RCD    - The program to use in place of CD (or CDD)
  98.     
  99.         
  100.  
  101.     Command Line format and Switches
  102.     --------------------------------
  103.  
  104.     RCD [-?] [-p] [-r] [-l] [-m] [-w] directory-name
  105.  
  106.     As usual, the stuff inside the square brackets "[]" are
  107.     optional and may be present or omitted. You do NOT include
  108.     the brackets in your command line.
  109.     The various fields and options may appear in any order, in
  110.     either upper or lower case.
  111.     The switch character can be either "-" or "/".
  112.  
  113.  
  114.  
  115.     If you just invoke RCD without any parameters, it gives you a
  116.     brief help line and shows the current disk & directory.
  117.     For more info, include '-?'.  For even more,
  118.     include '-??'.
  119.  
  120.     The parameter is all or part of the name of the directory you
  121.     want to switch to.  RCD uses the full (better than DOS) wildcard
  122.     matching that WIZ uses:  you can put "*" anywhere, and it 
  123.     matches zero or more characters, "?" matches exactly one 
  124.     character.  RCD first looks for a directory name which is
  125.     exactly the same as the parameter.  If it does not find one, it 
  126.     looks for a directory that starts with what you gave.  If it 
  127.     does not find one, it then looks for a directory with the 
  128.     characters you gave ANYWHERE in the name.  To be more precise, 
  129.     if you said "RCD xyz", the patterns it uses for the match are:
  130.         1st try: "XYZ"
  131.         2nd try: "XYZ*"
  132.         3rd try: "*XYZ*"
  133.         
  134.     However, if you include any wildcard characters ("*" or "?"), 
  135.     then RCD will assume that you know what matching pattern you 
  136.     want, and will only do one try, using the exact pattern given.
  137.     
  138.     If the directory parameter starts (or ends) with a "\", then this
  139.     is treated as if the -r (root only) or -l (leaf only) switch
  140.     was specified.
  141.     
  142.         
  143.     POPUP WINDOW
  144.     ------------
  145.     It is possible that RCD will find more than one directory that 
  146.     satisfies it (for example, I have sub-directories named TRY and 
  147.     TEMP all over my disk).  RCD will popup a scrolling window 
  148.     showing all the matching directory names.  The cursor will be 
  149.     positioned as follows: If the current directory is NOT a match, 
  150.     the cursor will be on the first line. If the current directory 
  151.     IS a match, then the cursor will be on the next line after the 
  152.     current directory.
  153.     
  154.     You can scroll thru the list using the UP/DOWN arrows, and
  155.     PAGEUP, PAGEDOWN, HOME, and END.  Hit ENTER to switch to the
  156.     highlighted directory. Hit ESC or CTRL/C to bail out.
  157.     
  158.     RCD recognizes when your display is set for more than 25 lines
  159.     (43, 50, or other), and adjusts the number of lines in the window
  160.     appropriately.
  161.     
  162.     
  163.  
  164.      -l    Leaf directory
  165.      --------------------
  166.     This switch says to only consider a directory that is a leaf 
  167.     (does not have any sub-directories below it).
  168.     
  169.     -p    Parent directory
  170.     ----------------------
  171.     This is the opposite of -l.  It says to only consider a 
  172.     directory if it DOES have at least one sub-directory.
  173.     
  174.     -r    Root directory
  175.     --------------------
  176.     This says to only consider a directory if it is at the highest 
  177.     level--it's in the root directory of a disk.
  178.  
  179.     -m    Monochrome display
  180.     ------------------------
  181.     Use this to force a black & white display window.  You may also
  182.     force mono by putting "/m" in the WIZ environment variable.    
  183.     
  184.     -w    Don't do popup window
  185.     ---------------------------
  186.     Don't do a popup window if there are several matching 
  187.     directories.  Instead, just switch to the "next" directory 
  188.     (according to the rules of positioning the cursor discussed 
  189.     above.)  If you re-execute the exact same RCD command, it will 
  190.     step thru all the matching directories in sequence.
  191.     
  192.     
  193.   *************************************************************************
  194.  
  195.     RCDSCAN [-v] [-?] [disks]
  196.     -----------------
  197.     You need to run RCDSCAN whenever you add, delete, move, or 
  198.     rename directories and/or drives.  It builds a data-base file
  199.     containing information about you disk and directory structure.
  200.     The data base is sorted in alphabetical order, so when RCD shows
  201.     several matching files, they will be in order, but by the name 
  202.     of the matching directory, NOT in tree order or in sorted order 
  203.     by directory level.
  204.     This file is: "C:\RCD.IDX"
  205.     
  206.     
  207.     Disk(s):
  208.     ---------------------------
  209.     You can specify the disk(s) you want it to scan, optionally
  210.     followed by ":".  It will look at those drives, in the order
  211.     you listed them.  If you list the same one twice, it will look
  212.     at it twice.  You can specify a range of disks by using a
  213.     dash--"C-F" is the same as "CDEF".
  214.     
  215.     CURRENT DISK--- If you start off with ":", rather than a [set of]
  216.     disk letter(s), then RCD will restrict itself to the current drive.
  217.     Example:      RCD :try  -- will look only on the current disk
  218.  
  219.  
  220.     If you don't list any disks, it will look at all drives 
  221.     beginning with C. It will stop when it hits a drive that it 
  222.     cannot read.
  223.  
  224.     Processing Disk(s) and Environment Variable 
  225.     -------------------------------------------
  226.     
  227.     You can override the disks that RCDSCAN looks at, and their 
  228.     order, by making an environment variable "WIZ".  Do: "SET 
  229.     WIZ=floppy-disk-list:hard-disk-list". Example: "SET WIZ=AB:C-M".  
  230.     What actually happens is that RCDSCAN will try to read all the 
  231.     disks to the left of the colon, then all those to the right of 
  232.     the colon.  Those on the left are deemed to be floppies, and 
  233.     will be ignored.  Those on the right are deemed to be hard 
  234.     drives, and it will quit on the first one that it can't read.
  235.  
  236.     You may omit the "default" disk set by leaving a space after
  237.     the "=".  This is most useful when you need only to put the
  238.     "/M" switch, as: "SET WIZ= /M".
  239.     
  240.     If you specify disks on the command line, it will try to read
  241.     them all, even if it can't read one.
  242.  
  243.     The list may be discontiguous, (e.g., "C-FL-M").  This is
  244.     mostly useful if you are on a network, which tends to make
  245.     the networked disks at the higher letters, and leaves a hole
  246.     before them.
  247.     
  248.  
  249.  
  250.     Pre-defined Drive Sets
  251.     ----------------------
  252.     You can actually have several pre-defined sets of disks to
  253.     search. If the disk-specifier on the command line is a single
  254.     digit (0-9), it will look for that specifier in the WIZ
  255.     variable.  For example, you might say:
  256.         "SET WIZ=AB:C-F  1=CDEG 2=AB:  3=C-Z 4=C-Z:"
  257.  
  258.     As above, those to the left of the colon are deemed floppies; 
  259.     those to the right are hard drives, and RCDSCAN will quit if it 
  260.     can't read one. However, if there isn't a colon, then they are 
  261.     ALL deemed to be hard drives.
  262.  
  263.     The command "RCDSCAN ", will look on ABCDEF.
  264.     The command "RCDSCAN 1:", will look on CDEF.
  265.     The command "RCDSCAN 2:", will look on AB.
  266.     The command "RCDSCAN 3:", will look on all drives C-Z (and
  267.         will quit at the first on that it can't read).
  268.     The command "RCDSCAN 4:", will look on all drives C-Z (and it
  269.         will attempt to read each and every one of them).
  270.     The command "RCDSCAN 9:", will give an error message.
  271.  
  272.  
  273.  
  274.  
  275.  
  276.     -v    Verbose
  277.     -------------
  278.     If you have this flag once, RCDSCAN will print the disk name when
  279.     it starts as it starts on a disk.  If you have it twice
  280.     (-vv), it will also print the name of each directory.
  281.     This is mostly useful for troubleshooting, or to see a 
  282.     progress indication.
  283.  
  284.             
  285.     
  286.     
  287.     It has been tested, and works, with DOS 3.x, including Zenith 
  288.     DOS 3.30, DOS 3.31, DOS 4.01, DOS 5.0, DOS 6.0, STACKER and 
  289.     DoubleSpace compressed pseudo-disks, and On-Track partitioning
  290.     software.  DOS 3.31, 4.01, and 5.0 have large (greater than 32MB)
  291.     partitions with more than 65,536 sectors. Zenith DOS 3.30 and 
  292.     On-Track have large partitions by virtue of using large 
  293.     sectors (1024, 2048, or 4096 bytes, rather than 512 bytes).
  294.  
  295.     
  296.  
  297.     
  298.  
  299.     Error Messages
  300.     --------------
  301.         "Can't tell if FAT-12 or FAT-16. Assuming FAT-16!"
  302.         Just what it says.  I've only seen this on networked
  303.         disk drives.  If you know how to RELIABLY tell what
  304.         type of FAT a disk has (other than going thru DOS),
  305.         please let me know.
  306.  
  307.     "malloc failed for FAT_buf!"
  308.         Can't allocate memory to read a FAT block.  Most
  309.         likely an internal error.
  310.  
  311.      "malloc failed for dir_sec_buf!"
  312.         Can't allocate memory to read in a directory sector.
  313.         Most likely an internal error.
  314.  
  315.     "Sorry, out of memory!!!"
  316.         You lose.
  317.  
  318.     "Can't open file:"
  319.         Failure to open an archive file.  Most likely a disk
  320.         error. Run CHKDSK.
  321.  
  322.     "Non-existant directory, you should run RCDSCAN!"
  323.         A directory is in the data-base, but does not exist on
  324.         the disk.  It was probably renamed or deleted, but you
  325.         didn't run RCDSCAN after doing so.
  326.  
  327.     BUGS
  328.     ----
  329.     No known bugs.  However, RCDSCAN mostly does not use DOS to
  330.     process a disk, so errors on my part, or a change in the disk
  331.     structure might break it.
  332.  
  333.     If you are having problems, try 1) use the "-v" switch, to
  334.     isolate the error to a specific disk,  2) use "-vv", to see
  335.     as it hits each sub-directory.  Then call or write me.
  336.  
  337.  
  338.     Coming Attractions
  339.     ------------------
  340.     * Ability to create, delete, rename, and move directories.    
  341.     * Plus other things I think of, or get suggested.
  342.  
  343.     This is shareware, so I'm probably more interested and 
  344.     receptive in hearing comments and suggestions than a commercial 
  345.     software publisher would be.  Just send them in, or give me a 
  346.     call.  I can't promise to fix bugs, or add specific features, 
  347.     but I'll listen to everything.  Even if you're cheap and 
  348.     haven't registered.
  349.  
  350.     
  351.     BBS Support & New Versions
  352.     --------------------------
  353.     There is no "official" support BBS.  However, I frequent these
  354.     local BBS's:
  355.         Chicken Coop      (708)658-1545   RIMENET =>THECOOP
  356.         Emporium          (708)551-4275   Fidonet 1:/115/551
  357.         Rainbow Draggin'  (708)854-1696   Spare phone line
  358.                           in my basement.
  359.  
  360.     Update History
  361.     --------------
  362.  
  363.     1.4    Initial public release
  364.     
  365.     1.5    Changed to scrollable window display
  366.     
  367.     1.6    Check & report disk read error.
  368.     
  369.     1.7    * Support for network drives
  370.         * leading :, for current drive only
  371.         * Fixed bug which sometimes left blank lines.
  372.         * Leading/trailing "\"
  373.         
  374.     1.9    * Old bug--didn't restore cursor shape properly (RCD).
  375.         * Fixed bugs with mono detection.
  376.         * Size window to number of matches.
  377.         * Fixed RCDSCAN - Would sometimes quit immediately.
  378.  
  379.     2.0    Was never released.
  380.  
  381.     2.1    Now checks for valid directories & directory structure.
  382.         Fixed a bug in processing large DUBLSPACE disks (DOS 6.0).
  383.         Fixed bug in window size & [sometimes] blanked out lines.
  384.  
  385.  
  386.  
  387.  
  388.                            --------------------------
  389.                              INVOICE / REGISTRATION
  390.                            --------------------------
  391.  
  392.  
  393.  
  394.           Sold to: ___________________________________________________
  395.  
  396.                    ___________________________________________________
  397.  
  398.                    ___________________________________________________
  399.  
  400.  
  401.              Date: ______________________________
  402.  
  403.  
  404.           ============================================================
  405.  
  406.  
  407.     I will normally send you the latest version on 5 1/4" disk.
  408.     Add $2 for 3 1/2" disk. (Net $22)
  409.     Delete $5 (per copy) if you DON'T want me to send you a disk!
  410.  
  411.           _____ copies of WIZ version ___ at $20 each $____________
  412.  
  413.           _____ copies of RCD version 2.1 at $20 each $____________
  414.  
  415.           _____ add $2 for 3.5" disk              $____________
  416.  
  417.       _____ delete $5 per copy for no disk (net $15)
  418.  
  419.         DISCOUNT for registering both is
  420.         $5 off.                  ____________
  421.  
  422.  
  423.  
  424.                                 TOTAL ENCLOSED.......  $____________
  425.     NOTE:
  426.     If you have the current version, I will send you
  427.     a disk with the NEXT version, when I release it,
  428.     unless you check here:
  429.  
  430.     Ray, YES, send me a disk NOW, even though I already
  431.     have the current version:  [__]
  432.  
  433.  
  434.  
  435.  
  436.       Where did you get your copy of RCD?
  437.       Shareware distributor name:___________________
  438.       BBS name: ____________________
  439.       BBS phone #:  ____________________
  440.  
  441.  
  442.                       Send this invoice and your check to:
  443.  
  444.                 Ray Van Tassle
  445.                 1020 Fox Run Lane
  446.                 Algonquin, Il. 60102
  447.                 (708)-658-4941
  448.  
  449.  
  450.  
  451.  
  452.           =============================================================
  453.  
  454.           Thank you for your support ............... Ray Van Tassle
  455.  
  456.